home *** CD-ROM | disk | FTP | other *** search
/ TPUG - Toronto PET Users Group / TPUG Users Group CD / TPUG Users Group CD.iso / AMIGA / AMICUS / AMICUS20.ADF / BobEd / BobEd.DOC < prev    next >
Text File  |  1989-01-27  |  8KB  |  200 lines
  1.  
  2.                        ******************************
  3.                        *                            *
  4.                        *        BobEd V 1.5         *
  5.                        *                            *
  6.                        *  A general purpose object  *
  7.                        *          editor            *
  8.                        *                            *
  9.                        *    ⌐ Peter Philip, 1986    *
  10.                        *                            *
  11.                        ******************************
  12.  
  13.       BobEd, the program's source and this document are all ⌐ Peter Philip.
  14.    However all of these may be copied freely provided that no fees except
  15.    normal copying charges or online service charges in the case of
  16.    downloading.  The source code for this program may be freely modified
  17.    as long as the copyright notice is left intact and the resulting
  18.    program is left in the public domain.  You may use parts of this
  19.    program in any original program as well.  I would be glad to hear any
  20.    comments, suggestions, bug reports, etc you may have about this
  21.    program and further programs along its line - you may write to me at
  22.    the address following the text.
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.                            INSTRUCTIONS FOR USE
  33.                            »»»»»»»»»»»»»»»»»»»»
  34.    1. General
  35.  
  36.       BobEd is a general purpose object editor that can be used to create
  37.    BOB's, sprites, gadgets or any other small graphic image.  Its
  38.    limitations are that it can create images up to 48 bits wide by 45 bits
  39.    high by 4 bits deep (16 colors).
  40.  
  41.       BobEd can edit nine objects on the screen at once.  Objects can be
  42.    saved in binary (not IFF) or C Data statements.  Binary saved objects
  43.    can be loaded in for later editing.
  44.  
  45.       Remember that to get back to the Workbench screen from a window
  46.    without front/back gadgets hold down the left Amiga key and N (back) or
  47.    M (front).  You will need these keys because BobEd has no front/back
  48.    gadgets.
  49.  
  50.  
  51.    2. Editing
  52.  
  53.       The large box to the left is the magnified edit box.  The nine small
  54.    boxes on the right are the actual size object boxes.
  55.  
  56.       To select a new object to work on, click the left button inside the
  57.    object you wish to edit.
  58.  
  59.       To clear individual pixels, select the background color and paint over
  60.    the pixels desired.  To clear the entire frame, select the menu option
  61.    "CLEAR" under the "EDIT" menu.  The "FLIP" option will flip the object
  62.    around the y-axis around the center of the object.  The "ROTATE" option
  63.    will rotate the object 90░ right.
  64.  
  65.  
  66.    3. Copying and Undoing
  67.  
  68.       To copy any frame to another frame: 1) first click on the frame to be
  69.    copied (if not already selected) and select "COPY" from the "COPY"
  70.    menu.  This will place the image in a buffer which remains intact until
  71.    wiped out by another COPY.  2) click on the box you wish to copy to
  72.    and select "PASTE" from the "COPY" menu.  You may PASTE this image as
  73.    much as you wish, just repeat step 2).
  74.  
  75.       You may also use the copy buffer as a primitive UNDO function, just
  76.    COPY the image before making a major change and if you wish to fix it,
  77.    PASTE the image back and you will have the image back from the time you
  78.    saved it.
  79.  
  80.  
  81.    4. Colors
  82.  
  83.       BobEd uses 4 bit planes on a lo-res screen, therefore you may edit
  84.    images with up to 16 colors.  To select a new color, click inside that
  85.    block of color.  Note that the box on the right will change to the new
  86.    color, also, the background color is on the extreme left - it is there,
  87.    you just can't see it (because it is the background!).  Use this color
  88.    to erase with.
  89.  
  90.       These colors are fixed within this program, meaning that you must use
  91.    these 16 to create your object but these may be changed within your own
  92.    program.  The importance of this will come later in the saving section
  93.    because this program allows you to save as many bit planes (up to 4) that
  94.    you want (sprites are 2, BOB's can be any and workbench gadgets are 2).
  95.    Therefore you MUST use the appropriate colors for your image - that is
  96.    if you plan to create a 2 bit plane (4 color) image you must use colors
  97.    0-3 (background, color1, color2, color3), similarily, if you are creating
  98.    a 3 bit plane object you must use colors 0-7; in general :
  99.  
  100.            Planes         # Of Colors       Use Colors
  101.            -------------------------------------------
  102.               1                 2              0-1
  103.               2                 4              0-3
  104.               3                 8              0-7
  105.               4                 16             0-15
  106.  
  107.       This is especially important when saving as C code because if you
  108.    use a color out of the specified range it will not be saved (see Saving
  109.    below).
  110.  
  111.  
  112.    4. Saving.
  113.  
  114.       To save an image, make it the current object (if not done already)
  115.    and select "SAVE" from the "FILE" menu.  A requester will now appear
  116.    asking for some information.  Click inside the file name box (the large
  117.    one) and type a name for the object, next select the number of bit planes
  118.    to save by clicking in the box on the right of the file name box,
  119.    pressing DEL and entering the desired number of planes (1-4 are valid).
  120.    The middle button labled "C" is the C-code switch, when the "C" is
  121.    highlighted, the object will be saved in C-code format; when it is not
  122.    highlighted it will be saved in binary format (see below for a
  123.    description of this format).  If you wish to edit the object at a later
  124.    time, you MUST save it in binary format - BobEd CANNOT load the C-code
  125.    data statements.  Finally, to save the object, click on "FRAME", you
  126.    will now see a crosshair on the edit box, click once on the upper left
  127.    hand corner of the object and drag out a box to the lower right hand
  128.    corner and click again - BobEd will now save your image.
  129.  
  130.       Note that when you save an obect as binary it will always save all
  131.    4 bits of the image for you.
  132.  
  133.       The following format of BobEd's binary save is simple :
  134.  
  135.       BYTE 1 : Hex FF   - a flag that this is not C code.
  136.       BYTE 2 : X0       - upper left hand corner (within box)
  137.       BYTE 3 : Y0
  138.       BYTE 4 : X1       - lower right hand corner (within box)
  139.       BYTE 5 : Y1
  140.  
  141.       BYTE 6 ->         - compressed binary data: since the program uses
  142.                           only 4 bits per pixel we can compress two bytes
  143.                           into one by shifting every second byte into the
  144.                           upper nybble (4 bits) of the saved byte.
  145.  
  146.  
  147.       Loading an image is very easy.  Select the object box that you want
  148.    to load the image into and select "LOAD" from the "FILE" menu, click
  149.    inside the file name box in the load requester and type the name - hit
  150.    return or "LOAD" when finished and the image should load,  If it does not
  151.    load, check to see if the name is correct and make sure the image you
  152.    are trying to load is in BINARY format (see above), if the load fails,
  153.    nothing will happen.
  154.  
  155.  
  156.    5. Compiling the source
  157.  
  158.       The source code for this program was written for Lattice C V3.03 and
  159.    consists of the following files :
  160.  
  161.        disk.c                           drawbox.c
  162.        events.c                         gadgets.c
  163.        main.c                           menus.c
  164.        requesters.c                     bobed.h
  165.  
  166.       There is also a script file called MakeBobEd that will compile the
  167.    source automatically and LinkBobEd which will link the resulting object
  168.    code.  The code compiles without errors.
  169.  
  170.  
  171.    6. Improvements
  172.  
  173.       Improvements slated for V 2.0 include :
  174.  
  175.       o  Load IFF brush
  176.       o  Save IFF brush
  177.       o  File requester with listing
  178.       o  Rotate by any angle at arbitrary point
  179.       o  Flip on both axis
  180.       o  Fill, Lines, Circles and Boxes
  181.       o  Edit larger objects with up to 5 bit planes
  182.       o  Edit Hi-Res objects
  183.       o  Edit color palette
  184.       o  Better speed
  185.  
  186.       Feel free to modify this program yourself in any way you want, just
  187.    leave my copyright notice in if you plan to distribute it.
  188.  
  189.  
  190.    7. Who am I ?
  191.  
  192.       Peter Philip
  193.       111 Ancaster Ct.
  194.       Dartmouth, Nova Scotia
  195.       B2V 1J2, Canada
  196.  
  197.  
  198.  
  199.  
  200.